From: Jonathan Lebon <jlebon@redhat.com>
Date: Thu, 10 Aug 2017 13:05:15 +0000 (-0400)
Subject: man: document configured branches
X-Git-Tag: archive/raspbian/2022.1-3+rpi1~1^2~4^2~33^2~16
X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:///%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:/?a=commitdiff_plain;h=d3a5d26176c88903f47a21f31b4154abd7631694;p=ostree.git

man: document configured branches

Closes: #1072

Closes: #1073
Approved by: guyshapiro
---

diff --git a/man/ostree-pull.xml b/man/ostree-pull.xml
index dd901aa2..d7831850 100644
--- a/man/ostree-pull.xml
+++ b/man/ostree-pull.xml
@@ -132,7 +132,7 @@ Boston, MA 02111-1307, USA.
 	  This command can retrieve just a specific commit, or go all
 	  the way to performing a full mirror of the remote
 	  repository.  If no <literal>BRANCH</literal> is specified,
-	  all branches are retrieved.
+	  all configured branches are retrieved.
         </para>
 
 	<para>
diff --git a/man/ostree-remote.xml b/man/ostree-remote.xml
index 2bb8aa71..bf41a10c 100644
--- a/man/ostree-remote.xml
+++ b/man/ostree-remote.xml
@@ -96,6 +96,13 @@ Boston, MA 02111-1307, USA.
         <para>
             Changes remote repository configurations.  The NAME refers to the name of the remote.
         </para>
+        <para>
+            The <literal>BRANCH</literal> arguments to the
+            <command>add</command> subcommand specifies the configured branches
+            for the remote. See the <literal>branches</literal> section in
+            <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+            for more information.
+        </para>
         <para>
             The <command>gpg-import</command> subcommand can associate GPG keys to a specific remote repository for use when pulling signed commits from that repository (if GPG verification is enabled).
         </para>
diff --git a/man/ostree.repo-config.xml b/man/ostree.repo-config.xml
index 90d0f3dc..cf0bf7c0 100644
--- a/man/ostree.repo-config.xml
+++ b/man/ostree.repo-config.xml
@@ -147,6 +147,13 @@ Boston, MA 02111-1307, USA.
         metadata: summary, static delta "superblocks".</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>branches</varname></term>
+        <listitem><para>A list of strings. Represents the default configured
+        branches to fetch from the remote when no specific branches are
+        requested during a pull operation.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><varname>proxy</varname></term>
         <listitem><para>A string value, if given should be a URL for a